GobiPBMgmtAPI.h

/*===========================================================================
FILE: 
   GobiPbMgmtAPI.h

DESCRIPTION:
   Gobi Phonebook Management APIs

Copyright (C) 2014 Sierra Wireless Incorporated. All rights reserved.
                   Sierra Wireless Proprietary/GTDR
==========================================================================*/

#ifndef GobiPbMgmtAPI_H
#define GobiPbMgmtAPI_H
/*=========================================================================*/
// Definitions
/*=========================================================================*/
#ifdef GOBIAPI_EXPORTS
        #define IMPORTGOBI extern "C" __declspec( dllexport )   
#else  //GOBIAPI_EXPORTS
        #ifdef __cplusplus
                /* C++ callable DLL */
                #define IMPORTGOBI extern "C" __declspec( dllimport )   
        #else
                /* C callable DLL */
                #define IMPORTGOBI __declspec( dllimport )
        #endif
#endif //GOBIAPI_EXPORTS

// Calling convention for API
#define GOBICALLBACK __stdcall
#define GOBICMAPI __stdcall

#ifdef __cplusplus
        extern "C" {
#endif


/*=========================================================================*/
// Structs
/*=========================================================================*/
#define MAX_PB_NO_LEN                           81
#define MAX_NO_OF_PB                            10
#define MAX_PB_DESCRIPTION_LENGTH       255

typedef struct
{
        WORD recordID;
    BYTE numType;
    BYTE numPlan;
    BYTE numLen;
        BYTE number[MAX_PB_DESCRIPTION_LENGTH];
        BYTE nameLen;
        BYTE name[MAX_PB_DESCRIPTION_LENGTH];   
} phonebookEntry;

//emergencyNumberEntry
typedef struct
{
        BYTE emergencyNumberType;
        BYTE sessionTypeValid;
        BYTE sessionType;
        BYTE categoryValid;
        BYTE category;
        BYTE numLen;
        BYTE number[MAX_PB_NO_LEN];
} emergencyNumberEntry;

typedef struct
{
        BYTE                    numInstances;
        phonebookEntry  phoneInfo[MAX_NO_OF_PB];
} arrPBInfo;

/*=========================================================================*/
// Callbacks
/*=========================================================================*/
// Phonebook Record Read callback function
typedef void (GOBICALLBACK * tFNPbRecordRead)(
        BYTE sessionType,
        WORD pbType,
        arrPBInfo* phoneBookEntry );

// Phonebook Ready callback function
typedef void (GOBICALLBACK * tFNAllPbInitDone)(
        BYTE noOfInstance,
        BYTE* arrSessionType,
        WORD* arrPbBitMask);

//Phonebook Emergency List callback function
typedef void (GOBICALLBACK * tFNEmergencyList)(
        BYTE noOfInstance,
        emergencyNumberEntry* arrEmergencyNumberEntry);

#ifdef __cplusplus
        };
#endif

/*=========================================================================*/
// Prototypes
/*=========================================================================*/
IMPORTGOBI ULONG GOBICMAPI GetPhonebookCapabilities(
        BYTE*           pSessionType,
        WORD*           pPbType,
        WORD*           pUsedRecords,
        WORD*           pMaxRecords,
        BYTE*           pMaxNumLen,
        BYTE*           pMaxNameLen
        );

IMPORTGOBI ULONG GOBICMAPI ReadPhonebookRecords(
        BYTE*           pSessionType,
        WORD*           pPbType,
        WORD*           pStartId,
        WORD*           pEndId,
        WORD*           pNumOfRecords
        );

IMPORTGOBI ULONG GOBICMAPI WritePhonebookRecord(
                BYTE*   pSessionType,
                WORD*   pPbType,
                WORD*   pRecordId,
                BYTE*   pNumType,
                BYTE*   pNumPlan,
                BYTE*   pNumLen,
                BYTE*   pArrNum,
                BYTE*   pNameLen,
                BYTE*   pArrName
        );

        IMPORTGOBI ULONG GOBICMAPI DeletePhonebookRecord(
        BYTE*           pSessionType,
        WORD*           pPbType,
        WORD*           pRecordId
        );

IMPORTGOBI ULONG GOBICMAPI SetEmergencyListCallback(
        tFNEmergencyList pCallback);

IMPORTGOBI ULONG GOBICMAPI SetAllPhonebookInitDoneCallback(
        tFNAllPbInitDone pCallback);
 // End of PBM group

#endif //GobiPbMgmtAPI_H